Amending GtkBuildable documentation.
authorTristan Van Berkom <tristan.van.berkom@gmail.com>
Thu, 20 May 2010 04:30:13 +0000 (00:30 -0400)
committerTristan Van Berkom <tristan.van.berkom@gmail.com>
Thu, 20 May 2010 04:33:20 +0000 (00:33 -0400)
GtkBuildable documentation has forever stated that "only
objects which implement GtkBuildable can parsed by GtkBuilder" fixed.

gtk/gtkbuildable.c

index 68e6f8f89c4207fa10452da4bd963f6a870954fa..12fc07791d0d20bfc91147832863c269af3b5fe3 100644 (file)
  * @Short_description: Interface for objects that can be built by GtkBuilder
  * @Title: GtkBuildable
  *
- * In order to allow construction from a <link linkend="BUILDER-UI">GtkBuilder
- * UI description</link>, an object class must implement the
- * GtkBuildable interface. The interface includes methods for setting
- * names and properties of objects, parsing custom tags, constructing
- * child objects.
+ * GtkBuildable allows objects to extend and customize thier deserialization 
+ * from <link linkend="BUILDER-UI">GtkBuilder UI descriptions</link>.
+ * The interface includes methods for setting names and properties of objects, 
+ * parsing custom tags and constructing child objects.
  *
  * The GtkBuildable interface is implemented by all widgets and
  * many of the non-widget objects that are provided by GTK+. The
  * main user of this interface is #GtkBuilder, there should be
  * very little need for applications to call any
  * <function>gtk_buildable_...</function> functions.
+ *
+ * <note><para>An object only needs to implement this interface if it needs
+ * to extend the #GtkBuilder format or run any extra routines at deserialization time</para></note>
  */
 
 #include "config.h"